package com.zy.explore.alibaba.interfaces.feign.base;

import com.zy.explore.alibaba.interfaces.frm.CommonIdFrm;
import com.zy.explore.alibaba.interfaces.vo.PageVO;

import com.zy.explore.alibaba.interfaces.frm.ExampleSaveFrm;
import com.zy.explore.alibaba.interfaces.frm.ExampleQueryFrm;
import com.zy.explore.alibaba.interfaces.vo.ExampleVO;
import com.zy.explore.alibaba.infrastructure.constant.ProjectConstant;

import org.springframework.cloud.openfeign.FeignClient;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.validation.annotation.Validated;

import java.util.List;

/**
 * description Mongo示例Facade
 *
 * @author ZY
 * @date 2021年05月19日 21:36
 */
@FeignClient(value = ProjectConstant.SERVICE_NAME, path = "/mongo", contextId = ProjectConstant.SERVICE_NAME + ".MongoExampleFeign")
public interface MongoExampleFeign {

    /**
     * 新增数据
     *
     * @param frm 待新增的Frm对象
     * @return 成功返回新增后的VO对象，失败返回null
     */
    @ApiOperation("1新增数据")
    @PostMapping("/insert")
    ExampleVO insert(@RequestBody @Validated ExampleSaveFrm frm);

    /**
     * 删除数据
     *
     * @param frm 主键Frm对象
     * @return 1:删除成功 其他:删除失败
     */
    @ApiOperation("2删除数据")
    @PostMapping("/delete")
    Integer delete(@RequestBody @Validated CommonIdFrm frm);

    /**
     * 更新数据
     *
     * @param frm 待更新的Frm对象
     * @return 成功返回更新后的VO对象，失败返回null
     */
    @ApiOperation("3更新数据")
    @PostMapping("/update")
    ExampleVO update(@RequestBody @Validated ExampleSaveFrm frm);

    /**
     * 通过主键查询单条数据
     *
     * @param frm 主键Frm对象
     * @return 成功返回对应ID的VO对象，查询不到返回null
     */
    @ApiOperation("4根据主键查询数据")
    @PostMapping("/findById")
    ExampleVO findById(@RequestBody @Validated CommonIdFrm frm);

    /**
     * 根据条件获取数据集
     *
     * @param frm 查询条件对象
     * @return 满足条件的数据集合,非null
     */
    @ApiOperation("5根据条件查询数据集")
    @PostMapping("/getList")
    List<ExampleVO> getList(@RequestBody @Validated ExampleQueryFrm frm);

    /**
     * 根据条件查询数据分页
     *
     * @param dto 查询条件参数
     * @return 成功返回满足条件的分页，非null
     */
    @ApiOperation("根据条件查询数据分页")
    @PostMapping("/getPageInfo")
    PageVO<ExampleVO> getPageInfo(@RequestBody @Validated ExampleQueryFrm dto);

}
